/*
 * Copyright (c) 2004-2024, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.resourcetable;

import java.util.List;
import java.util.Optional;
import org.hisp.dhis.db.model.Index;
import org.hisp.dhis.db.model.Table;

/**
 * Represents a resource database table.
 *
 * @author Lars Helge Overland
 */
public interface ResourceTable {
  /**
   * Returns the table definition.
   *
   * @return the {@link Table}.
   */
  Table getTable();

  /**
   * Returns the main table definition.
   *
   * @return the {@link Table}.
   */
  Table getMainTable();

  /**
   * Returns the table indexes.
   *
   * @return a list of {@link Index}.
   */
  default List<Index> getIndexes() {
    return List.of();
  }

  /**
   * Returns the resource table type.
   *
   * @return the {@link ResourceTableType}.
   */
  ResourceTableType getTableType();

  /**
   * Returns an optional SQL statement for populating the resource table.
   *
   * @return an optional SQL statement, may be empty.
   */
  Optional<String> getPopulateTempTableStatement();

  /**
   * Returns the content of a resource table as an optional list of objects arrays.
   *
   * @return an optional list of object arrays, may be empty.
   */
  Optional<List<Object[]>> getPopulateTempTableContent();
}
